<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>headset.peripherals.InputController'.TimedInputController</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="headset-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >HeaDSET</th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="headset-module.html">Package&nbsp;headset</a> ::
        <a href="headset.peripherals-module.html">Package&nbsp;peripherals</a> ::
        <a href="headset.peripherals.InputController%27-module.html">Module&nbsp;InputController'</a> ::
        Class&nbsp;TimedInputController
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class TimedInputController</h1><p class="nomargin-top"><span class="codelink"><a href="headset.peripherals.InputController%27-pysrc.html#TimedInputController">source&nbsp;code</a></span></p>
<center>
<center>  <map id="uml_class_diagram_for_headset__32" name="uml_class_diagram_for_headset__32">
<area shape="rect" href="headset.peripherals.InputController%27.TimedInputController-class.html#DoWork" title="headset.peripherals.InputController&#39;.TimedInputController.DoWork" alt="" coords="17,159,196,177"/>
<area shape="rect" href="headset.peripherals.InputController%27.TimedInputController-class.html#GetName" title="Returns the name of the InputController." alt="" coords="17,177,196,196"/>
<area shape="rect" href="headset.peripherals.InputController%27.TimedInputController-class.html#GetResolution" title="Returns the polling interval resolution" alt="" coords="17,196,196,215"/>
<area shape="rect" href="headset.peripherals.InputController%27.TimedInputController-class.html#IsRunning" title="Checks if the controller is running." alt="" coords="17,215,196,233"/>
<area shape="rect" href="headset.peripherals.InputController%27.TimedInputController-class.html#Start" title="Start polling" alt="" coords="17,233,196,252"/>
<area shape="rect" href="headset.peripherals.InputController%27.TimedInputController-class.html#Stop" title="Stop polling." alt="" coords="17,252,196,271"/>
<area shape="rect" href="headset.peripherals.InputController%27.TimedInputController-class.html#__init__" title="Constructor for the TimedInputController" alt="" coords="17,271,196,289"/>
<area shape="rect" href="headset.peripherals.InputController%27.TimedInputController-class.html" title="Extends the interface with a timer for timed polling." alt="" coords="16,133,197,291"/>
<area shape="rect" href="headset.peripherals.JoystickController%27.JoystickController-class.html" title="The SimpleJoyStickController uses the TimedInputController to poll it&#39;s self every 30 miliseconds." alt="" coords="19,320,195,347"/>
<area shape="rect" href="headset.peripherals.InputController%27.PolledInputController-class.html" title="The base class is extended with a method to poll the interface." alt="" coords="59,72,155,104"/>
<area shape="rect" href="headset.peripherals.InputController%27.InputController-class.html" title="Wraps third party input." alt="" coords="72,11,141,43"/>
</map>
  <img src="uml_class_diagram_for_headset__32.gif" alt='' usemap="#uml_class_diagram_for_headset__32" ismap="ismap" class="graph-without-title" />
</center>
</center>
<hr />
<p>Extends the interface with a timer for timed polling.</p>

<hr />
<div class="fields">      <p><strong>Version:</strong>
        1.0
      </p>
</div><!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Instance Methods</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-InstanceMethods"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="headset.peripherals.InputController%27.TimedInputController-class.html#DoWork" class="summary-sig-name">DoWork</a>(<span class="summary-sig-arg">self</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="headset.peripherals.InputController%27-pysrc.html#TimedInputController.DoWork">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="headset.peripherals.InputController%27.TimedInputController-class.html#GetName" class="summary-sig-name">GetName</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Returns the name of the InputController.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="headset.peripherals.InputController%27-pysrc.html#TimedInputController.GetName">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="headset.peripherals.InputController%27.TimedInputController-class.html#GetResolution" class="summary-sig-name">GetResolution</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Returns the polling interval resolution</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="headset.peripherals.InputController%27-pysrc.html#TimedInputController.GetResolution">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="headset.peripherals.InputController%27.TimedInputController-class.html#IsRunning" class="summary-sig-name">IsRunning</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Checks if the controller is running.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="headset.peripherals.InputController%27-pysrc.html#TimedInputController.IsRunning">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="headset.peripherals.InputController%27.TimedInputController-class.html#Start" class="summary-sig-name">Start</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Start polling</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="headset.peripherals.InputController%27-pysrc.html#TimedInputController.Start">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="headset.peripherals.InputController%27.TimedInputController-class.html#Stop" class="summary-sig-name">Stop</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Stop polling.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="headset.peripherals.InputController%27-pysrc.html#TimedInputController.Stop">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="headset.peripherals.InputController%27.TimedInputController-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">inputInterface</span>,
        <span class="summary-sig-arg">resolution</span>)</span><br />
      Constructor for the TimedInputController</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="headset.peripherals.InputController%27-pysrc.html#TimedInputController.__init__">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr class="private">
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="headset.peripherals.InputController%27.TimedInputController-class.html#_onTick" class="summary-sig-name" onclick="show_private();">_onTick</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">event</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="headset.peripherals.InputController%27-pysrc.html#TimedInputController._onTick">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Method Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-MethodDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="DoWork"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">DoWork</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="headset.peripherals.InputController%27-pysrc.html#TimedInputController.DoWork">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  
  <dl class="fields">
    <dt>Overrides:
        <a href="headset.peripherals.InputController%27.PolledInputController-class.html#DoWork">PolledInputController.DoWork</a>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="GetName"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">GetName</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="headset.peripherals.InputController%27-pysrc.html#TimedInputController.GetName">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns the name of the InputController.</p>
  <dl class="fields">
    <dt>Returns:</dt>
        <dd>The name.</dd>
    <dt>Overrides:
        <a href="headset.peripherals.InputController%27.InputController-class.html#GetName">InputController.GetName</a>
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="GetResolution"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">GetResolution</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="headset.peripherals.InputController%27-pysrc.html#TimedInputController.GetResolution">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns the polling interval resolution</p>
  <dl class="fields">
    <dt>Returns:</dt>
        <dd>Poll interval resolution</dd>
  </dl>
<div class="fields">      <p><strong>Version:</strong>
        1.0
      </p>
</div></td></tr></table>
</div>
<a name="IsRunning"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">IsRunning</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="headset.peripherals.InputController%27-pysrc.html#TimedInputController.IsRunning">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Checks if the controller is running.</p>
  <dl class="fields">
    <dt>Returns:</dt>
        <dd>True if running, false if not.</dd>
  </dl>
<div class="fields">      <p><strong>Version:</strong>
        1.0
      </p>
</div></td></tr></table>
</div>
<a name="Start"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">Start</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="headset.peripherals.InputController%27-pysrc.html#TimedInputController.Start">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Start polling</p>
  <dl class="fields">
    <dt>Overrides:
        <a href="headset.peripherals.InputController%27.InputController-class.html#Start">InputController.Start</a>
    </dt>
  </dl>
<div class="fields">      <p><strong>Version:</strong>
        1.0
      </p>
</div></td></tr></table>
</div>
<a name="Stop"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">Stop</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="headset.peripherals.InputController%27-pysrc.html#TimedInputController.Stop">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Stop polling.</p>
  <dl class="fields">
    <dt>Overrides:
        <a href="headset.peripherals.InputController%27.InputController-class.html#Stop">InputController.Stop</a>
    </dt>
  </dl>
<div class="fields">      <p><strong>Version:</strong>
        1.0
      </p>
</div></td></tr></table>
</div>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">inputInterface</span>,
        <span class="sig-arg">resolution</span>)</span>
    <br /><em class="fname">(Constructor)</em>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="headset.peripherals.InputController%27-pysrc.html#TimedInputController.__init__">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Constructor for the TimedInputController</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>resolution</code></strong> - The timer resolution</li>
    </ul></dd>
    <dt>Overrides:
        <a href="headset.peripherals.InputController%27.InputController-class.html#__init__">InputController.__init__</a>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="_onTick"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">_onTick</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">event</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="headset.peripherals.InputController%27-pysrc.html#TimedInputController._onTick">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="headset-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >HeaDSET</th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    <a href="epydoc-log.html">Generated by Epydoc
    3.0.1 on Wed Feb 25 12:57:59 2009</a>
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
